<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>v_sditxss: si570drv.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">v_sditxss
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('si570drv_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">si570drv.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains low-level driver functions for controlling the SiliconLabs Si570 clock generator as mounted on the ZCU106 demo board. </p>
<p>The user should refer to the hardware device specification for more details of the device operation.</p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who Date         Changes
</p>
<hr/>
<p>
1.0   ssh 07/05/2018      Initial release.
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a410224ed7cd70489944a0668cf3e8056"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si570drv_8c.html#a410224ed7cd70489944a0668cf3e8056">Si570_DoSettings</a> (u32 IICBaseAddress, u8 IICAddress1, u8 *BufPtr, int NumRegs)</td></tr>
<tr class="memdesc:a410224ed7cd70489944a0668cf3e8056"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a list of register settings to the Si570 clock generator.  <a href="#a410224ed7cd70489944a0668cf3e8056">More...</a><br/></td></tr>
<tr class="separator:a410224ed7cd70489944a0668cf3e8056"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef548e0580a2fece5b5e93a1d85e2693"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="si570drv_8c.html#aef548e0580a2fece5b5e93a1d85e2693">Si570_SetClock</a> (u32 IICBaseAddress, u8 IICAddress1, u32 RxRefClk)</td></tr>
<tr class="memdesc:aef548e0580a2fece5b5e93a1d85e2693"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the output frequency of the Si570 clock generator.  <a href="#aef548e0580a2fece5b5e93a1d85e2693">More...</a><br/></td></tr>
<tr class="separator:aef548e0580a2fece5b5e93a1d85e2693"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a410224ed7cd70489944a0668cf3e8056"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int Si570_DoSettings </td>
          <td>(</td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>IICBaseAddress</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>IICAddress1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8 *&#160;</td>
          <td class="paramname"><em>BufPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>NumRegs</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Send a list of register settings to the Si570 clock generator. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">IICBaseAddress</td><td>contains the base address of the IIC master device. </td></tr>
    <tr><td class="paramname">IICAddress1</td><td>contains the 7 bit IIC address of the Si570 device. </td></tr>
    <tr><td class="paramname">BufPtr</td><td>is a pointer to an array with alternating register addresses and register values to program into the Si570. The array length must be at least 2*NumRegs. </td></tr>
    <tr><td class="paramname">NumRegs</td><td>contains the number of registers to write.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SI570_SUCCESS for success</dd>
<dd>
SI570_ERR_IIC for IIC access failure,</dd>
<dd>
SI570_ERR_FREQ when the requested frequency cannot be generated</dd>
<dd>
SI570_ERR_PARM when the ClkSrc or ClkDest parameters are invalid or the ClkInFreq or ClkOutFreq are out of range.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Private function. Does not modify the contents of the buffer pointed to by BufPtr. </dd></dl>

<p>References <a class="el" href="si570drv_8h.html#a9ef1d169a38da27574eb409a2c39e4bc">SI570_DEBUG</a>, <a class="el" href="si570drv_8h.html#a4c977d089105b80401b25999319592d6">SI570_ERR_IIC</a>, <a class="el" href="si570drv_8h.html#aa3b93f5b0a7f2ddd3185c8bccac12dbb">SI570_ERR_PARM</a>, and <a class="el" href="si570drv_8h.html#a43c263718b91deff62ddd93694237479">SI570_SUCCESS</a>.</p>

<p>Referenced by <a class="el" href="xsdi__example_8c.html#aef548e0580a2fece5b5e93a1d85e2693">Si570_SetClock()</a>.</p>

</div>
</div>
<a class="anchor" id="aef548e0580a2fece5b5e93a1d85e2693"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int Si570_SetClock </td>
          <td>(</td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>IICBaseAddress</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>IICAddress1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>RxRefClk</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the output frequency of the Si570 clock generator. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">IICBaseAddress</td><td>contains the base address of the IIC master device. </td></tr>
    <tr><td class="paramname">IICAddress1</td><td>contains the 7 bit IIC address of the Si570 device.</td></tr>
    <tr><td class="paramname">RxRefClk</td><td>contains the value to be written in Si570 register for that particular clock frequency.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SI570_SUCCESS for success</dd>
<dd>
SI570_ERR_IIC for IIC access failure,</dd>
<dd>
SI570_ERR_FREQ when the requested frequency cannot be generated</dd>
<dd>
SI570_ERR_PARM when the ClkSrc or ClkDest parameters are invalid or the ClkInFreq or ClkOutFreq are out of range. </dd></dl>

<p>References <a class="el" href="si570drv_8h.html#a9ef1d169a38da27574eb409a2c39e4bc">SI570_DEBUG</a>, and <a class="el" href="si570drv_8c.html#a410224ed7cd70489944a0668cf3e8056">Si570_DoSettings()</a>.</p>

<p>Referenced by <a class="el" href="xsdi__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>, and <a class="el" href="xsdi__example_8c.html#a9bb5e8b35a95a9d610d2237baca5277c">RxStreamUpCallback()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
